Improve notification documentation

Ref: https://gitlab.gnome.org/GNOME/gnome-shell/issues/294

diff --git a/js/ui/messageList.js b/js/ui/messageList.js
index aff201ed6fc32efab281ecca98ca40c3af29c602..6ba5be8587a4ce849f2c71e3508c6deb81a9e1df 100644 (file)
--- a/js/ui/messageList.js
+++ b/js/ui/messageList.js
@@ -27,6 +27,7 @@ function _fixMarkup(text, allowMarkup) {
 
         // Support <b>, <i>, and <u>, escape anything else
         // so it displays as raw markup.
+        // Ref: https://developer.gnome.org/notification-spec/#markup
         _text = _text.replace(/<(?!\/?[biu]>)/g, '&lt;');
 
         try {

diff --git a/js/ui/messageTray.js b/js/ui/messageTray.js
index 9ce5b44607619f656cea7147fd750cf37a40dbab..463d40ecfe443b63dbe8f78906533b549c5c1fc1 100644 (file)
--- a/js/ui/messageTray.js
+++ b/js/ui/messageTray.js
@@ -315,10 +315,10 @@ var NotificationApplicationPolicy = new Lang.Class({
 // You can add a secondary icon to the banner with 'secondaryGIcon'. There
 // is no fallback for this icon.
 //
-// If @params contains 'bannerMarkup', with the value %true, then
-// the corresponding element is assumed to use pango markup. If the
-// parameter is not present for an element, then anything that looks
-// like markup in that element will appear literally in the output.
+// If @params contains 'bannerMarkup', with the value %true, a subset (<b>,
+// <i> and <u>) of the markup in [1] will be interpreted within @banner. If
+// the parameter is not present, then anything that looks like markup
+// in @banner will appear literally in the output.
 //
 // If @params contains a 'clear' parameter with the value %true, then
 // the content and the action area of the notification will be cleared.
@@ -328,6 +328,8 @@ var NotificationApplicationPolicy = new Lang.Class({
 // If @params contains 'soundName' or 'soundFile', the corresponding
 // event sound is played when the notification is shown (if the policy for
 // @source allows playing sounds).
+//
+// [1] https://developer.gnome.org/notification-spec/#markup 
 var Notification = new Lang.Class({
     Name: 'Notification',